Skip to content

fix(release-prepare): populate and backfill CHANGELOG entries#47

Merged
CybotTM merged 1 commit into
mainfrom
fix/release-prepare-changelog
Jul 2, 2026
Merged

fix(release-prepare): populate and backfill CHANGELOG entries#47
CybotTM merged 1 commit into
mainfrom
fix/release-prepare-changelog

Conversation

@CybotTM

@CybotTM CybotTM commented Jul 2, 2026

Copy link
Copy Markdown
Member

/release-prepare step 6 only renamed [Unreleased][X.Y.Z]. When changes land PR-by-PR without touching the changelog, [Unreleased] is empty and the rename yields a hollow version heading — which is exactly what happened across the last release batch (jira, matrix, netresearch-jira, it-maintenance all needed manual changelog entries + backfill after the fact; Copilot flagged jira-skill#151).

Step 6 now: derive entries from git log <last-tag>..HEAD, backfill any prior versions missing from the changelog, and add the new section in the file's own format. Never rename an empty section.

Copilot AI review requested due to automatic review settings July 2, 2026 00:49
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 2, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the release preparation documentation with detailed instructions on how to properly populate and update the CHANGELOG.md file. The review feedback suggests adding a fallback to the git command for repositories without existing tags, and updating the instructions to include modifying the link references at the bottom of Keep a Changelog files to prevent validation script failures.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread commands/release-prepare.md
Comment thread commands/release-prepare.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the /release-prepare command documentation to ensure CHANGELOG generation produces a populated release entry by deriving content from git history and backfilling missing tagged versions, preventing “hollow” releases when [Unreleased] is empty.

Changes:

  • Replace the “rename [Unreleased]” instruction with guidance to derive release notes from git log <last-tag>..HEAD.
  • Add instructions to backfill missing CHANGELOG sections for already-tagged versions.
  • Clarify insertion rules for Keep a Changelog vs. other CHANGELOG formats.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread commands/release-prepare.md Outdated
Comment thread commands/release-prepare.md Outdated
@CybotTM CybotTM force-pushed the fix/release-prepare-changelog branch from aab68c4 to 6776f3c Compare July 2, 2026 00:51
…mpty section

Step 6 only renamed [Unreleased] -> [X.Y.Z]. When changes are merged
PR-by-PR without touching the changelog, [Unreleased] is empty and the
rename produces a hollow version heading. Derive entries from the commit
log since the last tag, backfill any prior versions that shipped without
an entry, and match the file's existing style.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@CybotTM CybotTM force-pushed the fix/release-prepare-changelog branch from 6776f3c to 9c8e806 Compare July 2, 2026 00:55
@sonarqubecloud

sonarqubecloud Bot commented Jul 2, 2026

Copy link
Copy Markdown

@CybotTM CybotTM merged commit 2816a57 into main Jul 2, 2026
21 checks passed
@CybotTM CybotTM deleted the fix/release-prepare-changelog branch July 2, 2026 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants